home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 526-550 / disk_543 / preader / p-reader.doc < prev    next >
Text File  |  1992-05-06  |  13KB  |  289 lines
  1. PRE1
  2.                             P _ R E A D E R 
  3.  
  4.                                                                               
  5.    Yet another infernal Reader.  There are hundreds of them already, reliable,
  6.    comprehensive, user-friendly, sitting around pleading to be used.  So pick 
  7.    the Readers that will properly display texts with multiple colour and style
  8.    changes, compressed texts, ILBMs.   Now the list gets shorter!   Find the  
  9.    Readers that will also display animations and sounds. . . Finally find the 
  10.    Readers that will show illustrated texts, with pictures and animations     
  11.    mixed in with the words.   What, none?                                     
  12.                                                                               
  13.    Wrong.  One.                                                               
  14.                                                                                
  15.    First the general instructions.  press HELP for a summary.                 
  16.                                                                               
  17.  
  18.                              INSTRUCTIONS 
  19.                                      
  20.    Introduction
  22.       P-Reader can be used for:
  23.         All-purpose text reader.
  24.         Reader for special illustrated texts.
  25.         ILBM display, including HAM and cycling (where active).
  26.         Sounds (8SVX format).
  27.         ANIM5 type animation display.
  28.       
  29.       Texts, pictures and animations may be compressed (with P-Compress - to be
  30.   released shortly) or uncompressed.  P-Reader will check and act accordingly.
  31.  
  32.       This reader forms the core of the complete P-Suite system.  Also included
  33.   in the Suite, and being released over the next few months,  are:
  34.  
  35.     P-Writer.   A matching text editor with special facilities for writing in
  36.                 colour and style changes and calling up illustrations.
  37.     P-Compress. Compression and de-compression tool.
  38.     P-Check.    Utility for checking suitability of IFF illustrations - ILBM
  39.                 and ANIM.
  40.     P-Animate.  Full-featured 3-D animation programme.
  41.  
  42.   Calling
  43.       From CLI:   P-Reader <FILE>
  44.          if no file is given P-Reader will open showing a file requester.
  45.  
  46.       From Workbench:  Click the icon. 
  47.          P-Reader will again open with a file requester.
  48.          To open with a file (which may be a text, picture, or animation),
  49.            hold <SHIFT> click the P-Reader icon, double-click the file icon.
  50.  
  51.     If you have Arp Library installed the standard Arp file requester will   
  52.   be used.
  54.   Operation
  55.  
  56.      P-Reader is mainly controlled by the ten function keys.  To produce a key 
  57.   strip index switch the printer on and click twice on the strip below with
  58.   the RIGHT mouse button to print it.  Cut out, join, print "P-Reader" on the 
  59.   back and enclose between two strips of clear Con-Tact film.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. #! 1 1 15 0 reader.key
  67.  
  68.    F1: Move to Page [n].  To move to any page press <F1>, enter the number of 
  69.    the required page, press <RETURN>.
  70.  
  71.    F2, F3: Press <F2> or <F3> to get the first or last pages respectively.
  72.  
  73.    F4: Search.  Requester will appear.  Click on this and replace the word
  74.    "text" with the string  that you want to find.  Set case-sensitivity and
  75.    press <RETURN>.  The  search will always start at the beginning of the file.
  76.    A cursor will appear immediately before the required string.
  77.  
  78.    F5: Search again.  Search will continue from the last instance found.
  79.  
  80.     WARNING The Search window must remain active during the search process    
  81.    If your pointer automatically activates the window over which it is placed,
  82.      make sure that it remains over the Search window.                         
  83.  
  84.    F6: Print page.  The current page will be dumped to the printer.
  85.  
  86.    F7: Print file.  The whole file will be dumped.
  87.  
  88.    F8: Screen to back.  Since P-Reader opens its own screen & window, depth or
  89.    window shrinking gadgets are not useful.  <F8>, together with  <Amiga-N>
  90.    <Amiga-M> allow any screen to be brought up.
  91.  
  92.    F9: Load.  Brings up a file requester.  A new file can be selected at any
  93.    time.
  94.  
  95.    F10:  Save.  Brings up the file requester again.  The text will always be   
  96.    saved in normal un-compressed ASCii form.  ILBM illustrations in the text
  97.    will not be saved (but see below under "ILBM Display).  
  98.  
  99.    If you do not have the Arp library, a simple string gadget requester will
  100.    appear.  Enter the required file, press <return> and click <OK> or <CANCEL>.
  101.         
  102.    Additional functions are performed by page header gadgets. From left to 
  103.    right:
  104.  
  105.       Window close - terminates P-Reader.  
  106.  
  107.       Page up      - just click on it (L mouse button).
  108.  
  109.       NoP          - No Pictures. Toggles to suppress or enable graphics.
  110.                      Click it.
  111.  
  112.       NoC          - No Cycling.   Toggles to suppress or enable cycling.
  113.  
  114.       Page Down    - Just click on it.
  115.     
  116.  Window Size
  117.  
  118.     To make it possible to include illustrations a displayed P-Reader text has 
  119.   a set page size - no scrolling.
  120.   
  121.     As a simple text reader P-Reader opens a screen matching the current
  122.   display mode.  If however an illustrated file is loaded, a PAL (256 line) 
  123.   or NTSC (200 line) screen will be used according to detail in the file
  124.   header.
  125.  
  126.  ILBM Display
  127.  
  128.     To stop cycling click once with the LEFT mouse button.  Cycling must be 
  129.     stopped before you can move on.
  130.   
  131.     To dump to the printer click twice with the RIGHT mouse button.
  132.  
  133.     P-Reader can be used as a stand-alone ILBM viewer.  In this role it will
  134.   accept any of the standard view-modes and screen depths.  
  135.  
  136.     To start cycling press <TAB>.
  137.     To stop cycling click once with the LEFT mouse button.    
  138.     To dump to the printer click twice with the RIGHT mouse button.
  139.     To close the screen click once with the LEFT mouse button.
  140.  
  141.  ANIMATION Display
  142.  
  143.     ANIM5s (as produced by Videoscape and P-Animator, etc) can be shown either
  144.   as text illustrations or by themselves.  The animation will display its
  145.   opening screen while loading.
  146.  
  147.     To start the animation click the LEFT mouse button once.
  148.     To end the animation click again.
  149.     The animation must be run (a double-click suffices) before you can move on.
  150.  
  151.     Displaying large animations (not including the illustration on P8) usually
  152.   needs 1 Meg of memory.  Click on the NoP gadget above if you have less.
  153.  
  154.                            ILLUSTRATED TEXTS 
  155.  
  156.      The preparation of illustrated texts for P-Reader is much easier with 
  157.    P-Writer, its partner in the P-Suite stable.  However P-Writer is not
  158.    essential.
  159.  
  160.  Colour and Style Changes
  161.    The normal escape codes are used.    The most useful being:
  162.    reset   ^[[0;40m        b'ground Pen1  ^[[41m     style bold    ^[[1m
  163.    text Pen1   ^[[31m      b'ground Pen2  ^[[42m     style italic  ^[[3m 
  164.    text Pen2   ^[[32m      b'ground Pen3  ^[[43m     underline     ^[[4m
  165.    text Pen3   ^[[33m
  166.  
  167.    The initial ^[ represents the insert introducer or CSI, the non-printing
  168.    character produced by 'Esc'.  Refer to the instructions for your text
  169.    editor to see how to insert this.
  170.  
  171.  Three types of graphics (four if you count sounds) can be called :
  172.  
  173.  ILBMs (IFF pictures)                        
  174.    True ILBMs produced by DPaint or any of the standard drawing software can
  175.    be used, provided that:
  176.  
  177.      Size is no greater than 640 X 256 (PAL) or 640 X 200 (NTSC).
  178.      No HAM or HALFBRITE.
  179.      Depth is three planes (eight colours).
  180.  
  181.    The picture shares a screen with the text, so the palette used by the
  182.    picture will affect screen colours.  Wherever possible the first four 
  183.    colours of the picture should be close to 000, FFA, 3F3, F20.  The rest of
  184.    the default palette is 45F, FC8, A60, 0A0.
  185.  
  186.       Calling syntax:
  187.              <#><!> 1 [Left edge] [Top edge] [Cycling] [File]
  188.             
  189.    # followed immediately by ! is the Command Introducer      
  190.    or CI.   P-Reader treats this as an escape sequence
  191.    introducer and the characters between it and the end  
  192.    of the line are not printed. (Always put a command
  193.    sequence at the end of a line, not in the middle!).
  194.    #! 1 61 5 1 tree
  195.  
  196.     1:          Enter 1 to indicate Type ILBM.
  197.     Left edge:  Position of left edge of picture - column.        
  198.     Top Edge:   Position of top of picture - row.              Click LMB to   
  199.     Cycling:    Enter 1 to enable, 0 to disable.             stop cycling
  200.     File:       Full path and filename.               This is CI 1 61 5 1 tree
  201.  
  202.    The sequence may be placed anywhere on the page,
  203.  but is best put at the  bottom so that all text is displayed first.
  204.  
  205. ANIMATIONS                                     
  206.                                                     
  207.    This version supports straightforward ANIM5 animations as produced by
  208.  Videoscape, The Projector, P_Animator and others.  Full information on how to 
  209.  create animations for P-Reader will be given in P_Animator.    
  210.  
  211.    The command syntax is:                 
  212.                                 
  213.              <#><!> 2 0 0 0 [File]           
  214.                                
  215.    The sequence starts with the same CI as before. 
  216.  
  217.    2:     Type 2.  Animation.  
  218.    0 0 0  (For future expansion;  do not omit). 
  219.    File:  Full path and filename.               This is CI 2 0 0 0 fight.anim  
  220.                                                        Click LMB to start
  221.    The sequence can go anywhere on the page.           Click again to stop
  222.    There should be no text directly under the
  223.    anim.      #! 2 0 0 0 fight.anim
  224.  
  225.   UP TO THREE ILBMs OR ONE ANIM MAY BE
  226.   CALLED ON EACH PAGE
  227.  
  228.  SOUNDS
  229.  
  230.    Sound effects can be included if they are
  231.  in the normal 8SVX format.      #! 4 yuppy
  232.  
  233.    Command syntax:  <#><!> 4 [File]
  234.  
  235.    Sequence starts with the Command Introducer
  236.                                                             
  237.    4:        Type 4 - sound effect.                        
  238.    File:     Full path and filename.                      
  239.  
  240. BORDERS
  241.  
  242.    Provides a standard Intuition Border which may
  243.    be used to enclose text or  pictures.                         This is
  244.                                                              CI 3 56 14 19 5 6 
  246.      The command syntax is:
  247.      <#><!> 3 [Left edge] [Top line] [Width] [Height] [Pen] 
  248.      #! 3 61 11 18 5 6 
  249.    The sequence starts with the same CI as before.
  250.  
  251.    3:            Type 3 - means "Draw a Border".
  252.    Left edge:    First column to be included in the box.
  253.    Top line:     First line to be included.
  254.    Width:        Number of columns wide.                  
  255.    Height:       Number of lines high.            
  256.    Pen:          Pens 0 to 7 may be used.              
  257.                                      
  258.    The command sequence may be placed anywhere on the page, however to prevent 
  259.   the border from being over-written by text it is best put on a line below
  260.   where the  border will appear. 
  261.    
  262.  Identification
  263.  
  264.   To identify an illustrated text write the letters PRE at its very start,
  265.   followed immediately (no blank spaces) by 0 to indicate a PAL file or 1 for
  266.   an NTSC file.  
  267.  
  268.                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  269.  
  270.   Credit:  Yuppee sound stolen from Nic Wilson's SAM sound-reader. 
  271.  
  272.   P-Reader may be freely copied and circulated in whole or in part, provided 
  273.   that any distribution is accompanied by this file.   The programme may be
  274.   used for any non-commercial or non-profit-making purpose.  Authority for
  275.   commercial or profit-making purposes may be obtained from the author -
  276.   proposals for payment in kind will be looked on favorably. 
  277.  
  278.   Reactions, suggestions, bug-reports all welcome.
  279.  
  280.   A.M.H Wyndham
  281.   1265 Canning Mills Road,
  282.   Roleystone,
  283.   WA 6111
  284.   Australia
  285.  
  286.  
  287.  
  288.  
  289.